.TH E1432_SET_USER_DECIMATION 3 E1432
\fB---- NOT FOR GENERAL USE ----\fR
.SH NAME
.nf
e1432_set_user_decimation \- Set decimation factor for user data.
.fi
.IX e1432_set_user_decimation(3) 3
.SH SYNOPSIS
.cS
SHORTSIZ16 e1432_set_user_decimation(E1432ID hw, SHORTSIZ16 ID,
                     LONGSIZ32 user_decimation)
SHORTSIZ16 e1432_get_user_decimation(E1432ID hw, SHORTSIZ16 ID,
                     LONGSIZ32 *user_decimation)
.cE
.SH DESCRIPTION
\fIe1432_set_user_decimation\fR sets the user data frame decimation
factor of the modules(s) selected to the value given in \fIuser_decimation\fR.

\fIe1432_get_user_decimation\fR returns the user data frame decimation
factor of the modules(s) selected into a memory location pointed to by
\fIuser_decimation\fR.

This parameter is a "global" parameter.  It applies to an entire
module rather than to one of its channels.  The \fIID\fR parameter is
used only to identify which module the function applies to, and all
channels in that module will report the same value for this parameter.

\fIhw\fR must be the result of a successful call to
\fIe1432_assign_channel_numbers\fR, and specifies the group of
hardware to talk to.

\fIID\fR is either the ID of a group of channels that was obtained
with a call to \fIe1432_create_channel_group\fR, or the ID of a single
channel.
It is used to determine which module(s) in \fIhw\fR to set/query.

This parameter is valid only for E1433 modules and only applies when
special code has been downloaded using \fIe1432_sca_dsp_download\fR and
user data descrambling has been set up using \fIe1432_set_user_data\fR.

This allows 1 of N (N = user_decimation) frames to be output with the
other frames discarded.

This function is not currently implemented for any other SCA DSPs.

.SH "RESET VALUE"
After a reset, \fIuser_decimation\fR is set to 1, that is, no decimation.
.SH "RETURN VALUE"
Return 0 if successful, a (negative) error number otherwise.
.SH "SEE ALSO"
.na
e1432_sca_dsp_download
e1432_set_user_data
e1432_set_user_frames_per_block
.ad
